﻿/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// $Id: XMLConstants.java 446598 2006-09-15 12:55:40Z jeremias $

using System;
using java = biz.ritter.javapi;
using javax = biz.ritter.javapix;

namespace biz.ritter.javapix.xml
{

    /**
     * <p>Utility class to contain basic XML values as constants.</p>
     *
     * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a>
     * @version $Revision: 446598 $, $Date: 2006-09-15 08:55:40 -0400 (Fri, 15 Sep 2006) $
     * @see <a href="http://www.w3.org/TR/xml11/">Extensible Markup Language (XML) 1.1</a>
     * @see <a href="http://www.w3.org/TR/REC-xml">Extensible Markup Language (XML) 1.0 (Second Edition)</a>
     * @see <a href="http://www.w3.org/XML/xml-V10-2e-errata">XML 1.0 Second Edition Specification Errata</a>
     * @see <a href="http://www.w3.org/TR/xml-names11/">Namespaces in XML 1.1</a>
     * @see <a href="http://www.w3.org/TR/REC-xml-names">Namespaces in XML</a>
     * @see <a href="http://www.w3.org/XML/xml-names-19990114-errata">Namespaces in XML Errata</a>
     * @see <a href="http://www.w3.org/TR/xmlschema-1/">XML Schema Part 1: Structures</a>
     * @since 1.5
     **/

    public sealed class XMLConstants
    {

        /**
         * <p>Private constructor to prevent instantiation.</p>
         */
        private XMLConstants()
        {
        }

        /**
         * <p>Namespace URI to use to represent that there is no Namespace.</p>
         *
         * <p>Defined by the Namespace specification to be "".</p>
         *
         * @see <a href="http://www.w3.org/TR/REC-xml-names/#defaulting">
         * Namespaces in XML, 5.2 Namespace Defaulting</a>
         */
        public const String NULL_NS_URI = "";

        /**
         * <p>Prefix to use to represent the default XML Namespace.</p>
         *
         * <p>Defined by the XML specification to be "".</p>
         *
         * @see <a
         * href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
         * Namespaces in XML, 3. Qualified Names</a>
         */
        public const String DEFAULT_NS_PREFIX = "";

        /**
         * <p>The official XML Namespace name URI.</p>
         *
         * <p>Defined by the XML specification to be
         * "<code>http://www.w3.org/XML/1998/namespace</code>".</p>
         *
         * @see <a
         * href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
         * Namespaces in XML, 3. Qualified Names</a>
         */
        public const String XML_NS_URI =
            "http://www.w3.org/XML/1998/namespace";

        /**
         * <p>The official XML Namespace prefix.</p>
         *
         * <p>Defined by the XML specification to be "<code>xml</code>".</p>
         *
         * @see <a
         * href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
         * Namespaces in XML, 3. Qualified Names</a>
         */
        public const String XML_NS_PREFIX = "xml";

        /**
         * <p>The official XML attribute used for specifying XML Namespace
         * declarations, {@link #XMLNS_ATTRIBUTE
         * XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.</p>
         *
         * <p>Defined by the XML specification to be
         * "<code>http://www.w3.org/2000/xmlns/</code>".</p>
         *
         * @see <a
         * href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
         * Namespaces in XML, 3. Qualified Names</a>
         * @see <a
         * href="http://www.w3.org/XML/xml-names-19990114-errata/">
         * Namespaces in XML Errata</a>
         */
        public const String XMLNS_ATTRIBUTE_NS_URI =
            "http://www.w3.org/2000/xmlns/";

        /**
         * <p>The official XML attribute used for specifying XML Namespace
         * declarations.</p>
         *
         * <p>It is <strong><em>NOT</em></strong> valid to use as a
         * prefix.  Defined by the XML specification to be
         * "<code>xmlns</code>".</p>
         *
         * @see <a
         * href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
         * Namespaces in XML, 3. Qualified Names</a>
         */
        public const String XMLNS_ATTRIBUTE = "xmlns";

        /**
         * <p>W3C XML Schema Namespace URI.</p>
         * 
         * <p>Defined to be "<code>http://www.w3.org/2001/XMLSchema</code>".</p>
         * 
         * @see <a href=
         *  "http://www.w3.org/TR/xmlschema-1/#Instance_Document_Constructions">
         *  XML Schema Part 1:
         *  Structures, 2.6 Schema-Related Markup in Documents Being Validated</a>
         */
        public const String W3C_XML_SCHEMA_NS_URI =
            "http://www.w3.org/2001/XMLSchema";

        /**
         * <p>W3C XML Schema Instance Namespace URI.</p>
         * 
         * <p>Defined to be "<code>http://www.w3.org/2001/XMLSchema-instance</code>".</p>
         * 
         * @see <a href=
         *  "http://www.w3.org/TR/xmlschema-1/#Instance_Document_Constructions">
         *  XML Schema Part 1:
         *  Structures, 2.6 Schema-Related Markup in Documents Being Validated</a>
         */
        public const String W3C_XML_SCHEMA_INSTANCE_NS_URI =
            "http://www.w3.org/2001/XMLSchema-instance";

        /**
         * <p>W3C XPath Datatype Namespace URI.</p>
         * 
         * <p>Defined to be "<code>http://www.w3.org/2003/11/xpath-datatypes</code>".</p>
         * 
         * @see <a href="http://www.w3.org/TR/xpath-datamodel">XQuery 1.0 and XPath 2.0 Data Model</a>
         */
        public const String W3C_XPATH_DATATYPE_NS_URI = "http://www.w3.org/2003/11/xpath-datatypes";

        /**
         * <p>XML Document Type Declaration Namespace URI as an arbitrary value.</p>
         * 
         * <p>Since not formally defined by any existing standard, arbitrarily define to be "<code>http://www.w3.org/TR/REC-xml</code>".</p>
         */
        public const String XML_DTD_NS_URI = "http://www.w3.org/TR/REC-xml";

        /**
         * <p>RELAX NG Namespace URI.</p>
         * 
         * <p>Defined to be "<code>http://relaxng.org/ns/structure/1.0</code>".</p>
         * 
         * @see <a href="http://relaxng.org/spec-20011203.html">RELAX NG Specification</a>
         */
        public const String RELAXNG_NS_URI = "http://relaxng.org/ns/structure/1.0";

        /**
         * <p>Feature for secure processing.</p>
         * 
         * <ul>
         *   <li>
         *     <code>true</code> instructs the implementation to process XML securely.
         *     This may set limits on XML constructs to avoid conditions such as denial of service attacks.
         *   </li>
         *   <li>
         *     <code>false</code> instructs the implementation to process XML acording the letter of the XML specifications
         *     ingoring security issues such as limits on XML constructs to avoid conditions such as denial of service attacks.
         *   </li>
         * </ul>
         */
        public const String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing";
    }
}
